/*
 * Licensed to the Apache Software Foundation (ASF) under one
 *   or more contributor license agreements.  See the NOTICE file
 *   distributed with this work for additional information
 *   regarding copyright ownership.  The ASF licenses this file
 *   to you under the Apache License, Version 2.0 (the
 *   "License"); you may not use this file except in compliance
 *   with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */

package org.apache.phoenix.pherf.result;

import org.apache.phoenix.pherf.result.file.ResultFileDetails;

import java.util.List;

/**
 * This is a common interface for working with Pherf results in various output formats. Implementations of this
 * interface can deal with particular details for that format while giving callers to output a simple API to report
 * against.
 */
public interface ResultHandler {
    public void write(Result result) throws Exception;

    public void flush() throws Exception;

    public void close() throws Exception;

    public List<Result> read() throws Exception;

    public boolean isClosed();

    public ResultFileDetails getResultFileDetails();

    public String getResultFileName();

    public void setResultFileDetails(ResultFileDetails details);

    public void setResultFileName(String resultFileName);
}
